Incident Push

To register a callback, you just need provide two things.

Firstly, the language you'd like. IETF BCP 47 standard: {language}-{region}. For example: en-US.

Secondly and lastly, the callback. The callback contains url and appId which is for authentication. The url like https://{{host}}/xx/xx. The appId like "24416c36-d9c7-4d74-a047-d6ca461fxxxx". In addition, the http method should be post.

Then your callback will be invoked immediately when an incident occurs.

Demo curl:

curl -X POST "{{host}}" \
-H "accept: */*" \
-H "Content-Type: application/json" \
-d '{
  "appId": "{{appId}}",
  "payload": {
    "content": {
      "endTime": "",
      "incidentCode": "1011",
      "incidentId": "74bbc189-3313-4665-8204-9fbe45dfxxxx",
      "incidentLevel": "H2",
      "incidentName": "Clean water full",
      "incidentStatus": 1,
      "startTime": "2023-01-14T02:09:28Z",
      "taskId": "74bbc189-3313-4665-8204-9fbe45dfxxxx",
      "subTaskId": "74bbc189-3313-4665-8204-9fbe45dfxxxx",
      "taskInstanceId": "74bbc189-3313-4665-8204-9fbe45dfxxxx",
      "taskName": "74bbc189-3313-4665-8204-9fbe45dfxxxx",
      "mapId": "74bbc189-3313-4665-8204-9fbe45dfxxxx",
      "mapName": "74bbc189-3313-4665-8204-9fbe45dfxxxx"
    },
    "modelTypeCode": "Scrubber 50H",
    "serialNumber": "ITEST00-0000-000-XXXX"
  }
}'

Parameter description:

field name	field type	filed description	example
appId	String	for authentication	"24416c36-d9c7-4d74-a047-d6ca461fxxxx"
payload	Object	incident message content
payload.serialNumber	String	robot serial number	"TEST00-0000-000-XXXX"
payload.modelTypeCode	String	robot model type code	"Scrubber 50H"
payload.content	Object	incident content
payload.content.incidentCode	String	incident code	"1011"
payload.content.incidentName	String	incident name	"Clean water full"
payload.content.incidentLevel	String	incident level	"H2"
payload.content.incidentId	String	incident id	"c084a905-597e-4085-90dd-ecab697dxxxx"
payload.content.incidentStatus	int	incident status，1 alarm，0 recover	1
payload.content.startTime	String	incident start time. utc time zone	"2023-01-14T02:09:28Z"
payload.content.endTime	String	Incident end time，utc time zone. If the incident does not recover, end time is empty string	"2023-01-14T02:09:28Z" or ""
payload.content.taskId	String	The id of the task the robot is executing when the incident occurs.	"c084a905-597e-4085-90dd-ecab697dxxxx"
payload.content.subTaskId	String	The id of the subtaskid the robot is executing when the incident occurs.	"c084a905-597e-4085-90dd-ecab697dxxxx"
payload.content.taskInstanceId	String	The instance id of the task when the incident occurs.	"c084a905-597e-4085-90dd-ecab697dxxxx"
payload.content.taskName	String	The name of the task when the incident occurs.	"task1"
payload.content.mapId	String	The id of the map where the robot is located when the incident occurs.	"c084a905-597e-4085-90dd-ecab697dxxxx"
payload.content.mapName	String	The name of the map where the robot is located when the incident occurs.	"map1"

payload.content.incidentLevel:

value	name	description
H0	event	It is not an alarm, but only an event notification
H1	status	Buried point statistics
H2	status	The routine state of the robot can be solved by the user without any guidance
H3	warn	It does not affect the robot task. Users can solve
H4	assistance, problem	It does affect the robot task. Users can solve
H5	hidden danger	It does not affect the robot task. Users can not solve
H6	fault	It does affect the robot task. Users can not solve
H7	quality issues	Serious failure